/*	$Id: mpool.h 7 2008-07-29 02:58:11Z phrakt $	*/
/*
 * Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _PFORGE_MPOOL_H_
#define _PFORGE_MPOOL_H_

#include <sys/types.h>

/* memory pool flags */
#define MPF_HARD    0x01   /* hard pool, memory is locked */
#define MPF_SOFT    0x02   /* soft pool, memory can be paged */
#define MPF_CLEAR   0x04   /* clear all returned memory */


/* allocation modes */
#define MPALLOC_NOWAIT  0x01  /* do not block if no memory is available */
#define MPALLOC_WAIT    0x02  /* block until memory becomes available */


typedef struct pf_mpool PF_MPOOL;



PF_MPOOL* pf_mpool_alloc   (size_t, int, int);
void      pf_mpool_destroy (PF_MPOOL *);
void*     pf_mpool_get     (PF_MPOOL *, int);
void      pf_mpool_release (PF_MPOOL *, void *);

#ifdef DEBUG
void pfmpool_dump (PF_MPOOL *);
#endif

#endif	/* _PFORGE_MPOOL_H_ */
